<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2009 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import static com.google.common.base.Preconditions.checkArgument;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import static com.google.common.base.Preconditions.checkNotNull;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static com.google.common.collect.Maps.keyOrNull;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import com.google.common.annotations.GwtCompatible;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Arrays;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Collections;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Comparator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Map;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.NavigableMap;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.SortedMap;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.TreeMap;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>import javax.annotation.Nullable;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>/**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * An immutable {@link SortedMap}. Does not permit null keys or values.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;Unlike {@link Collections#unmodifiableSortedMap}, which is a &lt;i&gt;view&lt;/i&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * of a separate map which can still change, an instance of {@code<a name="line.41"></a>
<span class="sourceLineNo">042</span> * ImmutableSortedMap} contains its own data and will &lt;i&gt;never&lt;/i&gt; change.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * {@code ImmutableSortedMap} is convenient for {@code public static final} maps<a name="line.43"></a>
<span class="sourceLineNo">044</span> * ("constant maps") and also lets you easily make a "defensive copy" of a map<a name="line.44"></a>
<span class="sourceLineNo">045</span> * provided to your class by a caller.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;&lt;b&gt;Note:&lt;/b&gt; Although this class is not final, it cannot be subclassed as<a name="line.47"></a>
<span class="sourceLineNo">048</span> * it has no public or protected constructors. Thus, instances of this class are<a name="line.48"></a>
<span class="sourceLineNo">049</span> * guaranteed to be immutable.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.51"></a>
<span class="sourceLineNo">052</span> * "http://code.google.com/p/guava-libraries/wiki/ImmutableCollectionsExplained"&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * immutable collections&lt;/a&gt;.<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @author Jared Levy<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @author Louis Wasserman<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @since 2.0 (imported from Google Collections Library; implements {@code<a name="line.57"></a>
<span class="sourceLineNo">058</span> *        NavigableMap} since 12.0)<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span>@GwtCompatible(serializable = true, emulated = true)<a name="line.60"></a>
<span class="sourceLineNo">061</span>public abstract class ImmutableSortedMap&lt;K, V&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span>    extends ImmutableSortedMapFauxverideShim&lt;K, V&gt; implements NavigableMap&lt;K, V&gt; {<a name="line.62"></a>
<span class="sourceLineNo">063</span>  /*<a name="line.63"></a>
<span class="sourceLineNo">064</span>   * TODO(kevinb): Confirm that ImmutableSortedMap is faster to construct and<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * uses less memory than TreeMap; then say so in the class Javadoc.<a name="line.65"></a>
<span class="sourceLineNo">066</span>   */<a name="line.66"></a>
<span class="sourceLineNo">067</span>  private static final Comparator&lt;Comparable&gt; NATURAL_ORDER = Ordering.natural();<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>  private static final ImmutableSortedMap&lt;Comparable, Object&gt; NATURAL_EMPTY_MAP =<a name="line.69"></a>
<span class="sourceLineNo">070</span>      new EmptyImmutableSortedMap&lt;Comparable, Object&gt;(NATURAL_ORDER);<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>  static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; emptyMap(Comparator&lt;? super K&gt; comparator) {<a name="line.72"></a>
<span class="sourceLineNo">073</span>    if (Ordering.natural().equals(comparator)) {<a name="line.73"></a>
<span class="sourceLineNo">074</span>      return of();<a name="line.74"></a>
<span class="sourceLineNo">075</span>    } else {<a name="line.75"></a>
<span class="sourceLineNo">076</span>      return new EmptyImmutableSortedMap&lt;K, V&gt;(comparator);<a name="line.76"></a>
<span class="sourceLineNo">077</span>    }<a name="line.77"></a>
<span class="sourceLineNo">078</span>  }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>  static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; fromSortedEntries(<a name="line.80"></a>
<span class="sourceLineNo">081</span>      Comparator&lt;? super K&gt; comparator,<a name="line.81"></a>
<span class="sourceLineNo">082</span>      Collection&lt;? extends Entry&lt;? extends K, ? extends V&gt;&gt; entries) {<a name="line.82"></a>
<span class="sourceLineNo">083</span>    if (entries.isEmpty()) {<a name="line.83"></a>
<span class="sourceLineNo">084</span>      return emptyMap(comparator);<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    ImmutableList.Builder&lt;K&gt; keyBuilder = ImmutableList.builder();<a name="line.87"></a>
<span class="sourceLineNo">088</span>    ImmutableList.Builder&lt;V&gt; valueBuilder = ImmutableList.builder();<a name="line.88"></a>
<span class="sourceLineNo">089</span>    for (Entry&lt;? extends K, ? extends V&gt; entry : entries) {<a name="line.89"></a>
<span class="sourceLineNo">090</span>      keyBuilder.add(entry.getKey());<a name="line.90"></a>
<span class="sourceLineNo">091</span>      valueBuilder.add(entry.getValue());<a name="line.91"></a>
<span class="sourceLineNo">092</span>    }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span>    return new RegularImmutableSortedMap&lt;K, V&gt;(<a name="line.94"></a>
<span class="sourceLineNo">095</span>        new RegularImmutableSortedSet&lt;K&gt;(keyBuilder.build(), comparator),<a name="line.95"></a>
<span class="sourceLineNo">096</span>        valueBuilder.build());<a name="line.96"></a>
<span class="sourceLineNo">097</span>  }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>  static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; from(<a name="line.99"></a>
<span class="sourceLineNo">100</span>      ImmutableSortedSet&lt;K&gt; keySet, ImmutableList&lt;V&gt; valueList) {<a name="line.100"></a>
<span class="sourceLineNo">101</span>    if (keySet.isEmpty()) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>      return emptyMap(keySet.comparator());<a name="line.102"></a>
<span class="sourceLineNo">103</span>    } else {<a name="line.103"></a>
<span class="sourceLineNo">104</span>      return new RegularImmutableSortedMap&lt;K, V&gt;(<a name="line.104"></a>
<span class="sourceLineNo">105</span>          (RegularImmutableSortedSet&lt;K&gt;) keySet,<a name="line.105"></a>
<span class="sourceLineNo">106</span>          valueList);<a name="line.106"></a>
<span class="sourceLineNo">107</span>    }<a name="line.107"></a>
<span class="sourceLineNo">108</span>  }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>  /**<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * Returns the empty sorted map.<a name="line.111"></a>
<span class="sourceLineNo">112</span>   */<a name="line.112"></a>
<span class="sourceLineNo">113</span>  @SuppressWarnings("unchecked")<a name="line.113"></a>
<span class="sourceLineNo">114</span>  // unsafe, comparator() returns a comparator on the specified type<a name="line.114"></a>
<span class="sourceLineNo">115</span>  // TODO(kevinb): evaluate whether or not of().comparator() should return null<a name="line.115"></a>
<span class="sourceLineNo">116</span>  public static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; of() {<a name="line.116"></a>
<span class="sourceLineNo">117</span>    return (ImmutableSortedMap&lt;K, V&gt;) NATURAL_EMPTY_MAP;<a name="line.117"></a>
<span class="sourceLineNo">118</span>  }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>  /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>   * Returns an immutable map containing a single entry.<a name="line.121"></a>
<span class="sourceLineNo">122</span>   */<a name="line.122"></a>
<span class="sourceLineNo">123</span>  public static &lt;K extends Comparable&lt;? super K&gt;, V&gt;<a name="line.123"></a>
<span class="sourceLineNo">124</span>      ImmutableSortedMap&lt;K, V&gt; of(K k1, V v1) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>    return from(ImmutableSortedSet.of(k1), ImmutableList.of(v1));<a name="line.125"></a>
<span class="sourceLineNo">126</span>  }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>  /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>   * Returns an immutable sorted map containing the given entries, sorted by the<a name="line.129"></a>
<span class="sourceLineNo">130</span>   * natural ordering of their keys.<a name="line.130"></a>
<span class="sourceLineNo">131</span>   *<a name="line.131"></a>
<span class="sourceLineNo">132</span>   * @throws IllegalArgumentException if the two keys are equal according to<a name="line.132"></a>
<span class="sourceLineNo">133</span>   *     their natural ordering<a name="line.133"></a>
<span class="sourceLineNo">134</span>   */<a name="line.134"></a>
<span class="sourceLineNo">135</span>  public static &lt;K extends Comparable&lt;? super K&gt;, V&gt; ImmutableSortedMap&lt;K, V&gt;<a name="line.135"></a>
<span class="sourceLineNo">136</span>      of(K k1, V v1, K k2, V v2) {<a name="line.136"></a>
<span class="sourceLineNo">137</span>    return new Builder&lt;K, V&gt;(Ordering.natural())<a name="line.137"></a>
<span class="sourceLineNo">138</span>        .put(k1, v1).put(k2, v2).build();<a name="line.138"></a>
<span class="sourceLineNo">139</span>  }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>  /**<a name="line.141"></a>
<span class="sourceLineNo">142</span>   * Returns an immutable sorted map containing the given entries, sorted by the<a name="line.142"></a>
<span class="sourceLineNo">143</span>   * natural ordering of their keys.<a name="line.143"></a>
<span class="sourceLineNo">144</span>   *<a name="line.144"></a>
<span class="sourceLineNo">145</span>   * @throws IllegalArgumentException if any two keys are equal according to<a name="line.145"></a>
<span class="sourceLineNo">146</span>   *     their natural ordering<a name="line.146"></a>
<span class="sourceLineNo">147</span>   */<a name="line.147"></a>
<span class="sourceLineNo">148</span>  public static &lt;K extends Comparable&lt;? super K&gt;, V&gt; ImmutableSortedMap&lt;K, V&gt;<a name="line.148"></a>
<span class="sourceLineNo">149</span>      of(K k1, V v1, K k2, V v2, K k3, V v3) {<a name="line.149"></a>
<span class="sourceLineNo">150</span>    return new Builder&lt;K, V&gt;(Ordering.natural())<a name="line.150"></a>
<span class="sourceLineNo">151</span>        .put(k1, v1).put(k2, v2).put(k3, v3).build();<a name="line.151"></a>
<span class="sourceLineNo">152</span>  }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span>  /**<a name="line.154"></a>
<span class="sourceLineNo">155</span>   * Returns an immutable sorted map containing the given entries, sorted by the<a name="line.155"></a>
<span class="sourceLineNo">156</span>   * natural ordering of their keys.<a name="line.156"></a>
<span class="sourceLineNo">157</span>   *<a name="line.157"></a>
<span class="sourceLineNo">158</span>   * @throws IllegalArgumentException if any two keys are equal according to<a name="line.158"></a>
<span class="sourceLineNo">159</span>   *     their natural ordering<a name="line.159"></a>
<span class="sourceLineNo">160</span>   */<a name="line.160"></a>
<span class="sourceLineNo">161</span>  public static &lt;K extends Comparable&lt;? super K&gt;, V&gt; ImmutableSortedMap&lt;K, V&gt;<a name="line.161"></a>
<span class="sourceLineNo">162</span>      of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) {<a name="line.162"></a>
<span class="sourceLineNo">163</span>    return new Builder&lt;K, V&gt;(Ordering.natural())<a name="line.163"></a>
<span class="sourceLineNo">164</span>        .put(k1, v1).put(k2, v2).put(k3, v3).put(k4, v4).build();<a name="line.164"></a>
<span class="sourceLineNo">165</span>  }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>  /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>   * Returns an immutable sorted map containing the given entries, sorted by the<a name="line.168"></a>
<span class="sourceLineNo">169</span>   * natural ordering of their keys.<a name="line.169"></a>
<span class="sourceLineNo">170</span>   *<a name="line.170"></a>
<span class="sourceLineNo">171</span>   * @throws IllegalArgumentException if any two keys are equal according to<a name="line.171"></a>
<span class="sourceLineNo">172</span>   *     their natural ordering<a name="line.172"></a>
<span class="sourceLineNo">173</span>   */<a name="line.173"></a>
<span class="sourceLineNo">174</span>  public static &lt;K extends Comparable&lt;? super K&gt;, V&gt; ImmutableSortedMap&lt;K, V&gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span>      of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5) {<a name="line.175"></a>
<span class="sourceLineNo">176</span>    return new Builder&lt;K, V&gt;(Ordering.natural())<a name="line.176"></a>
<span class="sourceLineNo">177</span>        .put(k1, v1).put(k2, v2).put(k3, v3).put(k4, v4).put(k5, v5).build();<a name="line.177"></a>
<span class="sourceLineNo">178</span>  }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span>  /**<a name="line.180"></a>
<span class="sourceLineNo">181</span>   * Returns an immutable map containing the same entries as {@code map}, sorted<a name="line.181"></a>
<span class="sourceLineNo">182</span>   * by the natural ordering of the keys.<a name="line.182"></a>
<span class="sourceLineNo">183</span>   *<a name="line.183"></a>
<span class="sourceLineNo">184</span>   * &lt;p&gt;Despite the method name, this method attempts to avoid actually copying<a name="line.184"></a>
<span class="sourceLineNo">185</span>   * the data when it is safe to do so. The exact circumstances under which a<a name="line.185"></a>
<span class="sourceLineNo">186</span>   * copy will or will not be performed are undocumented and subject to change.<a name="line.186"></a>
<span class="sourceLineNo">187</span>   *<a name="line.187"></a>
<span class="sourceLineNo">188</span>   * &lt;p&gt;This method is not type-safe, as it may be called on a map with keys<a name="line.188"></a>
<span class="sourceLineNo">189</span>   * that are not mutually comparable.<a name="line.189"></a>
<span class="sourceLineNo">190</span>   *<a name="line.190"></a>
<span class="sourceLineNo">191</span>   * @throws ClassCastException if the keys in {@code map} are not mutually<a name="line.191"></a>
<span class="sourceLineNo">192</span>   *         comparable<a name="line.192"></a>
<span class="sourceLineNo">193</span>   * @throws NullPointerException if any key or value in {@code map} is null<a name="line.193"></a>
<span class="sourceLineNo">194</span>   * @throws IllegalArgumentException if any two keys are equal according to<a name="line.194"></a>
<span class="sourceLineNo">195</span>   *         their natural ordering<a name="line.195"></a>
<span class="sourceLineNo">196</span>   */<a name="line.196"></a>
<span class="sourceLineNo">197</span>  public static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; copyOf(<a name="line.197"></a>
<span class="sourceLineNo">198</span>      Map&lt;? extends K, ? extends V&gt; map) {<a name="line.198"></a>
<span class="sourceLineNo">199</span>    // Hack around K not being a subtype of Comparable.<a name="line.199"></a>
<span class="sourceLineNo">200</span>    // Unsafe, see ImmutableSortedSetFauxverideShim.<a name="line.200"></a>
<span class="sourceLineNo">201</span>    @SuppressWarnings("unchecked")<a name="line.201"></a>
<span class="sourceLineNo">202</span>    Ordering&lt;K&gt; naturalOrder = (Ordering&lt;K&gt;) Ordering.&lt;Comparable&gt;natural();<a name="line.202"></a>
<span class="sourceLineNo">203</span>    return copyOfInternal(map, naturalOrder);<a name="line.203"></a>
<span class="sourceLineNo">204</span>  }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>  /**<a name="line.206"></a>
<span class="sourceLineNo">207</span>   * Returns an immutable map containing the same entries as {@code map}, with<a name="line.207"></a>
<span class="sourceLineNo">208</span>   * keys sorted by the provided comparator.<a name="line.208"></a>
<span class="sourceLineNo">209</span>   *<a name="line.209"></a>
<span class="sourceLineNo">210</span>   * &lt;p&gt;Despite the method name, this method attempts to avoid actually copying<a name="line.210"></a>
<span class="sourceLineNo">211</span>   * the data when it is safe to do so. The exact circumstances under which a<a name="line.211"></a>
<span class="sourceLineNo">212</span>   * copy will or will not be performed are undocumented and subject to change.<a name="line.212"></a>
<span class="sourceLineNo">213</span>   *<a name="line.213"></a>
<span class="sourceLineNo">214</span>   * @throws NullPointerException if any key or value in {@code map} is null<a name="line.214"></a>
<span class="sourceLineNo">215</span>   * @throws IllegalArgumentException if any two keys are equal according to the<a name="line.215"></a>
<span class="sourceLineNo">216</span>   *         comparator<a name="line.216"></a>
<span class="sourceLineNo">217</span>   */<a name="line.217"></a>
<span class="sourceLineNo">218</span>  public static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; copyOf(<a name="line.218"></a>
<span class="sourceLineNo">219</span>      Map&lt;? extends K, ? extends V&gt; map, Comparator&lt;? super K&gt; comparator) {<a name="line.219"></a>
<span class="sourceLineNo">220</span>    return copyOfInternal(map, checkNotNull(comparator));<a name="line.220"></a>
<span class="sourceLineNo">221</span>  }<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span>  /**<a name="line.223"></a>
<span class="sourceLineNo">224</span>   * Returns an immutable map containing the same entries as the provided sorted<a name="line.224"></a>
<span class="sourceLineNo">225</span>   * map, with the same ordering.<a name="line.225"></a>
<span class="sourceLineNo">226</span>   *<a name="line.226"></a>
<span class="sourceLineNo">227</span>   * &lt;p&gt;Despite the method name, this method attempts to avoid actually copying<a name="line.227"></a>
<span class="sourceLineNo">228</span>   * the data when it is safe to do so. The exact circumstances under which a<a name="line.228"></a>
<span class="sourceLineNo">229</span>   * copy will or will not be performed are undocumented and subject to change.<a name="line.229"></a>
<span class="sourceLineNo">230</span>   *<a name="line.230"></a>
<span class="sourceLineNo">231</span>   * @throws NullPointerException if any key or value in {@code map} is null<a name="line.231"></a>
<span class="sourceLineNo">232</span>   */<a name="line.232"></a>
<span class="sourceLineNo">233</span>  @SuppressWarnings("unchecked")<a name="line.233"></a>
<span class="sourceLineNo">234</span>  public static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; copyOfSorted(<a name="line.234"></a>
<span class="sourceLineNo">235</span>      SortedMap&lt;K, ? extends V&gt; map) {<a name="line.235"></a>
<span class="sourceLineNo">236</span>    Comparator&lt;? super K&gt; comparator = map.comparator();<a name="line.236"></a>
<span class="sourceLineNo">237</span>    if (comparator == null) {<a name="line.237"></a>
<span class="sourceLineNo">238</span>      // If map has a null comparator, the keys should have a natural ordering,<a name="line.238"></a>
<span class="sourceLineNo">239</span>      // even though K doesn't explicitly implement Comparable.<a name="line.239"></a>
<span class="sourceLineNo">240</span>      comparator = (Comparator&lt;? super K&gt;) NATURAL_ORDER;<a name="line.240"></a>
<span class="sourceLineNo">241</span>    }<a name="line.241"></a>
<span class="sourceLineNo">242</span>    return copyOfInternal(map, comparator);<a name="line.242"></a>
<span class="sourceLineNo">243</span>  }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span>  private static &lt;K, V&gt; ImmutableSortedMap&lt;K, V&gt; copyOfInternal(<a name="line.245"></a>
<span class="sourceLineNo">246</span>      Map&lt;? extends K, ? extends V&gt; map, Comparator&lt;? super K&gt; comparator) {<a name="line.246"></a>
<span class="sourceLineNo">247</span>    boolean sameComparator = false;<a name="line.247"></a>
<span class="sourceLineNo">248</span>    if (map instanceof SortedMap) {<a name="line.248"></a>
<span class="sourceLineNo">249</span>      SortedMap&lt;?, ?&gt; sortedMap = (SortedMap&lt;?, ?&gt;) map;<a name="line.249"></a>
<span class="sourceLineNo">250</span>      Comparator&lt;?&gt; comparator2 = sortedMap.comparator();<a name="line.250"></a>
<span class="sourceLineNo">251</span>      sameComparator = (comparator2 == null)<a name="line.251"></a>
<span class="sourceLineNo">252</span>          ? comparator == NATURAL_ORDER<a name="line.252"></a>
<span class="sourceLineNo">253</span>          : comparator.equals(comparator2);<a name="line.253"></a>
<span class="sourceLineNo">254</span>    }<a name="line.254"></a>
<span class="sourceLineNo">255</span><a name="line.255"></a>
<span class="sourceLineNo">256</span>    if (sameComparator &amp;&amp; (map instanceof ImmutableSortedMap)) {<a name="line.256"></a>
<span class="sourceLineNo">257</span>      // TODO(kevinb): Prove that this cast is safe, even though<a name="line.257"></a>
<span class="sourceLineNo">258</span>      // Collections.unmodifiableSortedMap requires the same key type.<a name="line.258"></a>
<span class="sourceLineNo">259</span>      @SuppressWarnings("unchecked")<a name="line.259"></a>
<span class="sourceLineNo">260</span>      ImmutableSortedMap&lt;K, V&gt; kvMap = (ImmutableSortedMap&lt;K, V&gt;) map;<a name="line.260"></a>
<span class="sourceLineNo">261</span>      if (!kvMap.isPartialView()) {<a name="line.261"></a>
<span class="sourceLineNo">262</span>        return kvMap;<a name="line.262"></a>
<span class="sourceLineNo">263</span>      }<a name="line.263"></a>
<span class="sourceLineNo">264</span>    }<a name="line.264"></a>
<span class="sourceLineNo">265</span><a name="line.265"></a>
<span class="sourceLineNo">266</span>    // "adding" type params to an array of a raw type should be safe as<a name="line.266"></a>
<span class="sourceLineNo">267</span>    // long as no one can ever cast that same array instance back to a<a name="line.267"></a>
<span class="sourceLineNo">268</span>    // raw type.<a name="line.268"></a>
<span class="sourceLineNo">269</span>    @SuppressWarnings("unchecked")<a name="line.269"></a>
<span class="sourceLineNo">270</span>    Entry&lt;K, V&gt;[] entries = map.entrySet().toArray(new Entry[0]);<a name="line.270"></a>
<span class="sourceLineNo">271</span><a name="line.271"></a>
<span class="sourceLineNo">272</span>    for (int i = 0; i &lt; entries.length; i++) {<a name="line.272"></a>
<span class="sourceLineNo">273</span>      Entry&lt;K, V&gt; entry = entries[i];<a name="line.273"></a>
<span class="sourceLineNo">274</span>      entries[i] = entryOf(entry.getKey(), entry.getValue());<a name="line.274"></a>
<span class="sourceLineNo">275</span>    }<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span>    List&lt;Entry&lt;K, V&gt;&gt; list = Arrays.asList(entries);<a name="line.277"></a>
<span class="sourceLineNo">278</span><a name="line.278"></a>
<span class="sourceLineNo">279</span>    if (!sameComparator) {<a name="line.279"></a>
<span class="sourceLineNo">280</span>      sortEntries(list, comparator);<a name="line.280"></a>
<span class="sourceLineNo">281</span>      validateEntries(list, comparator);<a name="line.281"></a>
<span class="sourceLineNo">282</span>    }<a name="line.282"></a>
<span class="sourceLineNo">283</span><a name="line.283"></a>
<span class="sourceLineNo">284</span>    return fromSortedEntries(comparator, list);<a name="line.284"></a>
<span class="sourceLineNo">285</span>  }<a name="line.285"></a>
<span class="sourceLineNo">286</span><a name="line.286"></a>
<span class="sourceLineNo">287</span>  private static &lt;K, V&gt; void sortEntries(<a name="line.287"></a>
<span class="sourceLineNo">288</span>      List&lt;Entry&lt;K, V&gt;&gt; entries, final Comparator&lt;? super K&gt; comparator) {<a name="line.288"></a>
<span class="sourceLineNo">289</span>    Comparator&lt;Entry&lt;K, V&gt;&gt; entryComparator = new Comparator&lt;Entry&lt;K, V&gt;&gt;() {<a name="line.289"></a>
<span class="sourceLineNo">290</span><a name="line.290"></a>
<span class="sourceLineNo">291</span>      @Override public int compare(Entry&lt;K, V&gt; entry1, Entry&lt;K, V&gt; entry2) {<a name="line.291"></a>
<span class="sourceLineNo">292</span>        return comparator.compare(entry1.getKey(), entry2.getKey());<a name="line.292"></a>
<span class="sourceLineNo">293</span>      }<a name="line.293"></a>
<span class="sourceLineNo">294</span>    };<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span>    Collections.sort(entries, entryComparator);<a name="line.296"></a>
<span class="sourceLineNo">297</span>  }<a name="line.297"></a>
<span class="sourceLineNo">298</span><a name="line.298"></a>
<span class="sourceLineNo">299</span>  private static &lt;K, V&gt; void validateEntries(List&lt;Entry&lt;K, V&gt;&gt; entries,<a name="line.299"></a>
<span class="sourceLineNo">300</span>      Comparator&lt;? super K&gt; comparator) {<a name="line.300"></a>
<span class="sourceLineNo">301</span>    for (int i = 1; i &lt; entries.size(); i++) {<a name="line.301"></a>
<span class="sourceLineNo">302</span>      if (comparator.compare(<a name="line.302"></a>
<span class="sourceLineNo">303</span>          entries.get(i - 1).getKey(), entries.get(i).getKey()) == 0) {<a name="line.303"></a>
<span class="sourceLineNo">304</span>        throw new IllegalArgumentException(<a name="line.304"></a>
<span class="sourceLineNo">305</span>            "Duplicate keys in mappings " + entries.get(i - 1) + " and "<a name="line.305"></a>
<span class="sourceLineNo">306</span>                + entries.get(i));<a name="line.306"></a>
<span class="sourceLineNo">307</span>      }<a name="line.307"></a>
<span class="sourceLineNo">308</span>    }<a name="line.308"></a>
<span class="sourceLineNo">309</span>  }<a name="line.309"></a>
<span class="sourceLineNo">310</span><a name="line.310"></a>
<span class="sourceLineNo">311</span>  /**<a name="line.311"></a>
<span class="sourceLineNo">312</span>   * Returns a builder that creates immutable sorted maps whose keys are<a name="line.312"></a>
<span class="sourceLineNo">313</span>   * ordered by their natural ordering. The sorted maps use {@link<a name="line.313"></a>
<span class="sourceLineNo">314</span>   * Ordering#natural()} as the comparator.<a name="line.314"></a>
<span class="sourceLineNo">315</span>   */<a name="line.315"></a>
<span class="sourceLineNo">316</span>  public static &lt;K extends Comparable&lt;?&gt;, V&gt; Builder&lt;K, V&gt; naturalOrder() {<a name="line.316"></a>
<span class="sourceLineNo">317</span>    return new Builder&lt;K, V&gt;(Ordering.natural());<a name="line.317"></a>
<span class="sourceLineNo">318</span>  }<a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span>  /**<a name="line.320"></a>
<span class="sourceLineNo">321</span>   * Returns a builder that creates immutable sorted maps with an explicit<a name="line.321"></a>
<span class="sourceLineNo">322</span>   * comparator. If the comparator has a more general type than the map's keys,<a name="line.322"></a>
<span class="sourceLineNo">323</span>   * such as creating a {@code SortedMap&lt;Integer, String&gt;} with a {@code<a name="line.323"></a>
<span class="sourceLineNo">324</span>   * Comparator&lt;Number&gt;}, use the {@link Builder} constructor instead.<a name="line.324"></a>
<span class="sourceLineNo">325</span>   *<a name="line.325"></a>
<span class="sourceLineNo">326</span>   * @throws NullPointerException if {@code comparator} is null<a name="line.326"></a>
<span class="sourceLineNo">327</span>   */<a name="line.327"></a>
<span class="sourceLineNo">328</span>  public static &lt;K, V&gt; Builder&lt;K, V&gt; orderedBy(Comparator&lt;K&gt; comparator) {<a name="line.328"></a>
<span class="sourceLineNo">329</span>    return new Builder&lt;K, V&gt;(comparator);<a name="line.329"></a>
<span class="sourceLineNo">330</span>  }<a name="line.330"></a>
<span class="sourceLineNo">331</span><a name="line.331"></a>
<span class="sourceLineNo">332</span>  /**<a name="line.332"></a>
<span class="sourceLineNo">333</span>   * Returns a builder that creates immutable sorted maps whose keys are<a name="line.333"></a>
<span class="sourceLineNo">334</span>   * ordered by the reverse of their natural ordering.<a name="line.334"></a>
<span class="sourceLineNo">335</span>   */<a name="line.335"></a>
<span class="sourceLineNo">336</span>  public static &lt;K extends Comparable&lt;?&gt;, V&gt; Builder&lt;K, V&gt; reverseOrder() {<a name="line.336"></a>
<span class="sourceLineNo">337</span>    return new Builder&lt;K, V&gt;(Ordering.natural().reverse());<a name="line.337"></a>
<span class="sourceLineNo">338</span>  }<a name="line.338"></a>
<span class="sourceLineNo">339</span><a name="line.339"></a>
<span class="sourceLineNo">340</span>  /**<a name="line.340"></a>
<span class="sourceLineNo">341</span>   * A builder for creating immutable sorted map instances, especially {@code<a name="line.341"></a>
<span class="sourceLineNo">342</span>   * public static final} maps ("constant maps"). Example: &lt;pre&gt;   {@code<a name="line.342"></a>
<span class="sourceLineNo">343</span>   *<a name="line.343"></a>
<span class="sourceLineNo">344</span>   *   static final ImmutableSortedMap&lt;Integer, String&gt; INT_TO_WORD =<a name="line.344"></a>
<span class="sourceLineNo">345</span>   *       new ImmutableSortedMap.Builder&lt;Integer, String&gt;(Ordering.natural())<a name="line.345"></a>
<span class="sourceLineNo">346</span>   *           .put(1, "one")<a name="line.346"></a>
<span class="sourceLineNo">347</span>   *           .put(2, "two")<a name="line.347"></a>
<span class="sourceLineNo">348</span>   *           .put(3, "three")<a name="line.348"></a>
<span class="sourceLineNo">349</span>   *           .build();}&lt;/pre&gt;<a name="line.349"></a>
<span class="sourceLineNo">350</span>   *<a name="line.350"></a>
<span class="sourceLineNo">351</span>   * For &lt;i&gt;small&lt;/i&gt; immutable sorted maps, the {@code ImmutableSortedMap.of()}<a name="line.351"></a>
<span class="sourceLineNo">352</span>   * methods are even more convenient.<a name="line.352"></a>
<span class="sourceLineNo">353</span>   *<a name="line.353"></a>
<span class="sourceLineNo">354</span>   * &lt;p&gt;Builder instances can be reused - it is safe to call {@link #build}<a name="line.354"></a>
<span class="sourceLineNo">355</span>   * multiple times to build multiple maps in series. Each map is a superset of<a name="line.355"></a>
<span class="sourceLineNo">356</span>   * the maps created before it.<a name="line.356"></a>
<span class="sourceLineNo">357</span>   *<a name="line.357"></a>
<span class="sourceLineNo">358</span>   * @since 2.0 (imported from Google Collections Library)<a name="line.358"></a>
<span class="sourceLineNo">359</span>   */<a name="line.359"></a>
<span class="sourceLineNo">360</span>  public static class Builder&lt;K, V&gt; extends ImmutableMap.Builder&lt;K, V&gt; {<a name="line.360"></a>
<span class="sourceLineNo">361</span>    private final Comparator&lt;? super K&gt; comparator;<a name="line.361"></a>
<span class="sourceLineNo">362</span><a name="line.362"></a>
<span class="sourceLineNo">363</span>    /**<a name="line.363"></a>
<span class="sourceLineNo">364</span>     * Creates a new builder. The returned builder is equivalent to the builder<a name="line.364"></a>
<span class="sourceLineNo">365</span>     * generated by {@link ImmutableSortedMap#orderedBy}.<a name="line.365"></a>
<span class="sourceLineNo">366</span>     */<a name="line.366"></a>
<span class="sourceLineNo">367</span>    public Builder(Comparator&lt;? super K&gt; comparator) {<a name="line.367"></a>
<span class="sourceLineNo">368</span>      this.comparator = checkNotNull(comparator);<a name="line.368"></a>
<span class="sourceLineNo">369</span>    }<a name="line.369"></a>
<span class="sourceLineNo">370</span><a name="line.370"></a>
<span class="sourceLineNo">371</span>    /**<a name="line.371"></a>
<span class="sourceLineNo">372</span>     * Associates {@code key} with {@code value} in the built map. Duplicate<a name="line.372"></a>
<span class="sourceLineNo">373</span>     * keys, according to the comparator (which might be the keys' natural<a name="line.373"></a>
<span class="sourceLineNo">374</span>     * order), are not allowed, and will cause {@link #build} to fail.<a name="line.374"></a>
<span class="sourceLineNo">375</span>     */<a name="line.375"></a>
<span class="sourceLineNo">376</span>    @Override public Builder&lt;K, V&gt; put(K key, V value) {<a name="line.376"></a>
<span class="sourceLineNo">377</span>      entries.add(entryOf(key, value));<a name="line.377"></a>
<span class="sourceLineNo">378</span>      return this;<a name="line.378"></a>
<span class="sourceLineNo">379</span>    }<a name="line.379"></a>
<span class="sourceLineNo">380</span><a name="line.380"></a>
<span class="sourceLineNo">381</span>    /**<a name="line.381"></a>
<span class="sourceLineNo">382</span>     * Adds the given {@code entry} to the map, making it immutable if<a name="line.382"></a>
<span class="sourceLineNo">383</span>     * necessary. Duplicate keys, according to the comparator (which might be<a name="line.383"></a>
<span class="sourceLineNo">384</span>     * the keys' natural order), are not allowed, and will cause {@link #build}<a name="line.384"></a>
<span class="sourceLineNo">385</span>     * to fail.<a name="line.385"></a>
<span class="sourceLineNo">386</span>     *<a name="line.386"></a>
<span class="sourceLineNo">387</span>     * @since 11.0<a name="line.387"></a>
<span class="sourceLineNo">388</span>     */<a name="line.388"></a>
<span class="sourceLineNo">389</span>    @Override public Builder&lt;K, V&gt; put(Entry&lt;? extends K, ? extends V&gt; entry) {<a name="line.389"></a>
<span class="sourceLineNo">390</span>      super.put(entry);<a name="line.390"></a>
<span class="sourceLineNo">391</span>      return this;<a name="line.391"></a>
<span class="sourceLineNo">392</span>    }<a name="line.392"></a>
<span class="sourceLineNo">393</span><a name="line.393"></a>
<span class="sourceLineNo">394</span>    /**<a name="line.394"></a>
<span class="sourceLineNo">395</span>     * Associates all of the given map's keys and values in the built map.<a name="line.395"></a>
<span class="sourceLineNo">396</span>     * Duplicate keys, according to the comparator (which might be the keys'<a name="line.396"></a>
<span class="sourceLineNo">397</span>     * natural order), are not allowed, and will cause {@link #build} to fail.<a name="line.397"></a>
<span class="sourceLineNo">398</span>     *<a name="line.398"></a>
<span class="sourceLineNo">399</span>     * @throws NullPointerException if any key or value in {@code map} is null<a name="line.399"></a>
<span class="sourceLineNo">400</span>     */<a name="line.400"></a>
<span class="sourceLineNo">401</span>    @Override public Builder&lt;K, V&gt; putAll(Map&lt;? extends K, ? extends V&gt; map) {<a name="line.401"></a>
<span class="sourceLineNo">402</span>      for (Entry&lt;? extends K, ? extends V&gt; entry : map.entrySet()) {<a name="line.402"></a>
<span class="sourceLineNo">403</span>        put(entry.getKey(), entry.getValue());<a name="line.403"></a>
<span class="sourceLineNo">404</span>      }<a name="line.404"></a>
<span class="sourceLineNo">405</span>      return this;<a name="line.405"></a>
<span class="sourceLineNo">406</span>    }<a name="line.406"></a>
<span class="sourceLineNo">407</span><a name="line.407"></a>
<span class="sourceLineNo">408</span>    /**<a name="line.408"></a>
<span class="sourceLineNo">409</span>     * Returns a newly-created immutable sorted map.<a name="line.409"></a>
<span class="sourceLineNo">410</span>     *<a name="line.410"></a>
<span class="sourceLineNo">411</span>     * @throws IllegalArgumentException if any two keys are equal according to<a name="line.411"></a>
<span class="sourceLineNo">412</span>     *     the comparator (which might be the keys' natural order)<a name="line.412"></a>
<span class="sourceLineNo">413</span>     */<a name="line.413"></a>
<span class="sourceLineNo">414</span>    @Override public ImmutableSortedMap&lt;K, V&gt; build() {<a name="line.414"></a>
<span class="sourceLineNo">415</span>      sortEntries(entries, comparator);<a name="line.415"></a>
<span class="sourceLineNo">416</span>      validateEntries(entries, comparator);<a name="line.416"></a>
<span class="sourceLineNo">417</span>      return fromSortedEntries(comparator, entries);<a name="line.417"></a>
<span class="sourceLineNo">418</span>    }<a name="line.418"></a>
<span class="sourceLineNo">419</span>  }<a name="line.419"></a>
<span class="sourceLineNo">420</span><a name="line.420"></a>
<span class="sourceLineNo">421</span>  ImmutableSortedMap() {<a name="line.421"></a>
<span class="sourceLineNo">422</span>  }<a name="line.422"></a>
<span class="sourceLineNo">423</span><a name="line.423"></a>
<span class="sourceLineNo">424</span>  ImmutableSortedMap(ImmutableSortedMap&lt;K, V&gt; descendingMap) {<a name="line.424"></a>
<span class="sourceLineNo">425</span>    this.descendingMap = descendingMap;<a name="line.425"></a>
<span class="sourceLineNo">426</span>  }<a name="line.426"></a>
<span class="sourceLineNo">427</span><a name="line.427"></a>
<span class="sourceLineNo">428</span>  @Override<a name="line.428"></a>
<span class="sourceLineNo">429</span>  public int size() {<a name="line.429"></a>
<span class="sourceLineNo">430</span>    return values().size();<a name="line.430"></a>
<span class="sourceLineNo">431</span>  }<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span>  @Override public boolean containsValue(@Nullable Object value) {<a name="line.433"></a>
<span class="sourceLineNo">434</span>    return values().contains(value);<a name="line.434"></a>
<span class="sourceLineNo">435</span>  }<a name="line.435"></a>
<span class="sourceLineNo">436</span><a name="line.436"></a>
<span class="sourceLineNo">437</span>  @Override boolean isPartialView() {<a name="line.437"></a>
<span class="sourceLineNo">438</span>    return keySet().isPartialView() || values().isPartialView();<a name="line.438"></a>
<span class="sourceLineNo">439</span>  }<a name="line.439"></a>
<span class="sourceLineNo">440</span><a name="line.440"></a>
<span class="sourceLineNo">441</span>  /**<a name="line.441"></a>
<span class="sourceLineNo">442</span>   * Returns an immutable set of the mappings in this map, sorted by the key<a name="line.442"></a>
<span class="sourceLineNo">443</span>   * ordering.<a name="line.443"></a>
<span class="sourceLineNo">444</span>   */<a name="line.444"></a>
<span class="sourceLineNo">445</span>  @Override public ImmutableSet&lt;Entry&lt;K, V&gt;&gt; entrySet() {<a name="line.445"></a>
<span class="sourceLineNo">446</span>    return super.entrySet();<a name="line.446"></a>
<span class="sourceLineNo">447</span>  }<a name="line.447"></a>
<span class="sourceLineNo">448</span><a name="line.448"></a>
<span class="sourceLineNo">449</span>  /**<a name="line.449"></a>
<span class="sourceLineNo">450</span>   * Returns an immutable sorted set of the keys in this map.<a name="line.450"></a>
<span class="sourceLineNo">451</span>   */<a name="line.451"></a>
<span class="sourceLineNo">452</span>  @Override public abstract ImmutableSortedSet&lt;K&gt; keySet();<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span>  /**<a name="line.454"></a>
<span class="sourceLineNo">455</span>   * Returns an immutable collection of the values in this map, sorted by the<a name="line.455"></a>
<span class="sourceLineNo">456</span>   * ordering of the corresponding keys.<a name="line.456"></a>
<span class="sourceLineNo">457</span>   */<a name="line.457"></a>
<span class="sourceLineNo">458</span>  @Override public abstract ImmutableCollection&lt;V&gt; values();<a name="line.458"></a>
<span class="sourceLineNo">459</span><a name="line.459"></a>
<span class="sourceLineNo">460</span>  /**<a name="line.460"></a>
<span class="sourceLineNo">461</span>   * Returns the comparator that orders the keys, which is<a name="line.461"></a>
<span class="sourceLineNo">462</span>   * {@link Ordering#natural()} when the natural ordering of the keys is used.<a name="line.462"></a>
<span class="sourceLineNo">463</span>   * Note that its behavior is not consistent with {@link TreeMap#comparator()},<a name="line.463"></a>
<span class="sourceLineNo">464</span>   * which returns {@code null} to indicate natural ordering.<a name="line.464"></a>
<span class="sourceLineNo">465</span>   */<a name="line.465"></a>
<span class="sourceLineNo">466</span>  @Override<a name="line.466"></a>
<span class="sourceLineNo">467</span>  public Comparator&lt;? super K&gt; comparator() {<a name="line.467"></a>
<span class="sourceLineNo">468</span>    return keySet().comparator();<a name="line.468"></a>
<span class="sourceLineNo">469</span>  }<a name="line.469"></a>
<span class="sourceLineNo">470</span><a name="line.470"></a>
<span class="sourceLineNo">471</span>  @Override<a name="line.471"></a>
<span class="sourceLineNo">472</span>  public K firstKey() {<a name="line.472"></a>
<span class="sourceLineNo">473</span>    return keySet().first();<a name="line.473"></a>
<span class="sourceLineNo">474</span>  }<a name="line.474"></a>
<span class="sourceLineNo">475</span><a name="line.475"></a>
<span class="sourceLineNo">476</span>  @Override<a name="line.476"></a>
<span class="sourceLineNo">477</span>  public K lastKey() {<a name="line.477"></a>
<span class="sourceLineNo">478</span>    return keySet().last();<a name="line.478"></a>
<span class="sourceLineNo">479</span>  }<a name="line.479"></a>
<span class="sourceLineNo">480</span><a name="line.480"></a>
<span class="sourceLineNo">481</span>  /**<a name="line.481"></a>
<span class="sourceLineNo">482</span>   * This method returns a {@code ImmutableSortedMap}, consisting of the entries<a name="line.482"></a>
<span class="sourceLineNo">483</span>   * whose keys are less than {@code toKey}.<a name="line.483"></a>
<span class="sourceLineNo">484</span>   *<a name="line.484"></a>
<span class="sourceLineNo">485</span>   * &lt;p&gt;The {@link SortedMap#headMap} documentation states that a submap of a<a name="line.485"></a>
<span class="sourceLineNo">486</span>   * submap throws an {@link IllegalArgumentException} if passed a {@code toKey}<a name="line.486"></a>
<span class="sourceLineNo">487</span>   * greater than an earlier {@code toKey}. However, this method doesn't throw<a name="line.487"></a>
<span class="sourceLineNo">488</span>   * an exception in that situation, but instead keeps the original {@code<a name="line.488"></a>
<span class="sourceLineNo">489</span>   * toKey}.<a name="line.489"></a>
<span class="sourceLineNo">490</span>   */<a name="line.490"></a>
<span class="sourceLineNo">491</span>  @Override<a name="line.491"></a>
<span class="sourceLineNo">492</span>  public ImmutableSortedMap&lt;K, V&gt; headMap(K toKey) {<a name="line.492"></a>
<span class="sourceLineNo">493</span>    return headMap(toKey, false);<a name="line.493"></a>
<span class="sourceLineNo">494</span>  }<a name="line.494"></a>
<span class="sourceLineNo">495</span><a name="line.495"></a>
<span class="sourceLineNo">496</span>  /**<a name="line.496"></a>
<span class="sourceLineNo">497</span>   * This method returns a {@code ImmutableSortedMap}, consisting of the entries<a name="line.497"></a>
<span class="sourceLineNo">498</span>   * whose keys are less than (or equal to, if {@code inclusive}) {@code toKey}.<a name="line.498"></a>
<span class="sourceLineNo">499</span>   *<a name="line.499"></a>
<span class="sourceLineNo">500</span>   * &lt;p&gt;The {@link SortedMap#headMap} documentation states that a submap of a<a name="line.500"></a>
<span class="sourceLineNo">501</span>   * submap throws an {@link IllegalArgumentException} if passed a {@code toKey}<a name="line.501"></a>
<span class="sourceLineNo">502</span>   * greater than an earlier {@code toKey}. However, this method doesn't throw<a name="line.502"></a>
<span class="sourceLineNo">503</span>   * an exception in that situation, but instead keeps the original {@code<a name="line.503"></a>
<span class="sourceLineNo">504</span>   * toKey}.<a name="line.504"></a>
<span class="sourceLineNo">505</span>   *<a name="line.505"></a>
<span class="sourceLineNo">506</span>   * @since 12.0<a name="line.506"></a>
<span class="sourceLineNo">507</span>   */<a name="line.507"></a>
<span class="sourceLineNo">508</span>  @Override<a name="line.508"></a>
<span class="sourceLineNo">509</span>  public abstract ImmutableSortedMap&lt;K, V&gt; headMap(K toKey, boolean inclusive);<a name="line.509"></a>
<span class="sourceLineNo">510</span><a name="line.510"></a>
<span class="sourceLineNo">511</span>  /**<a name="line.511"></a>
<span class="sourceLineNo">512</span>   * This method returns a {@code ImmutableSortedMap}, consisting of the entries<a name="line.512"></a>
<span class="sourceLineNo">513</span>   * whose keys ranges from {@code fromKey}, inclusive, to {@code toKey},<a name="line.513"></a>
<span class="sourceLineNo">514</span>   * exclusive.<a name="line.514"></a>
<span class="sourceLineNo">515</span>   *<a name="line.515"></a>
<span class="sourceLineNo">516</span>   * &lt;p&gt;The {@link SortedMap#subMap} documentation states that a submap of a<a name="line.516"></a>
<span class="sourceLineNo">517</span>   * submap throws an {@link IllegalArgumentException} if passed a {@code<a name="line.517"></a>
<span class="sourceLineNo">518</span>   * fromKey} less than an earlier {@code fromKey}. However, this method doesn't<a name="line.518"></a>
<span class="sourceLineNo">519</span>   * throw an exception in that situation, but instead keeps the original {@code<a name="line.519"></a>
<span class="sourceLineNo">520</span>   * fromKey}. Similarly, this method keeps the original {@code toKey}, instead<a name="line.520"></a>
<span class="sourceLineNo">521</span>   * of throwing an exception, if passed a {@code toKey} greater than an earlier<a name="line.521"></a>
<span class="sourceLineNo">522</span>   * {@code toKey}.<a name="line.522"></a>
<span class="sourceLineNo">523</span>   */<a name="line.523"></a>
<span class="sourceLineNo">524</span>  @Override<a name="line.524"></a>
<span class="sourceLineNo">525</span>  public ImmutableSortedMap&lt;K, V&gt; subMap(K fromKey, K toKey) {<a name="line.525"></a>
<span class="sourceLineNo">526</span>    return subMap(fromKey, true, toKey, false);<a name="line.526"></a>
<span class="sourceLineNo">527</span>  }<a name="line.527"></a>
<span class="sourceLineNo">528</span><a name="line.528"></a>
<span class="sourceLineNo">529</span>  /**<a name="line.529"></a>
<span class="sourceLineNo">530</span>   * This method returns a {@code ImmutableSortedMap}, consisting of the entries<a name="line.530"></a>
<span class="sourceLineNo">531</span>   * whose keys ranges from {@code fromKey} to {@code toKey}, inclusive or<a name="line.531"></a>
<span class="sourceLineNo">532</span>   * exclusive as indicated by the boolean flags.<a name="line.532"></a>
<span class="sourceLineNo">533</span>   *<a name="line.533"></a>
<span class="sourceLineNo">534</span>   * &lt;p&gt;The {@link SortedMap#subMap} documentation states that a submap of a<a name="line.534"></a>
<span class="sourceLineNo">535</span>   * submap throws an {@link IllegalArgumentException} if passed a {@code<a name="line.535"></a>
<span class="sourceLineNo">536</span>   * fromKey} less than an earlier {@code fromKey}. However, this method doesn't<a name="line.536"></a>
<span class="sourceLineNo">537</span>   * throw an exception in that situation, but instead keeps the original {@code<a name="line.537"></a>
<span class="sourceLineNo">538</span>   * fromKey}. Similarly, this method keeps the original {@code toKey}, instead<a name="line.538"></a>
<span class="sourceLineNo">539</span>   * of throwing an exception, if passed a {@code toKey} greater than an earlier<a name="line.539"></a>
<span class="sourceLineNo">540</span>   * {@code toKey}.<a name="line.540"></a>
<span class="sourceLineNo">541</span>   *<a name="line.541"></a>
<span class="sourceLineNo">542</span>   * @since 12.0<a name="line.542"></a>
<span class="sourceLineNo">543</span>   */<a name="line.543"></a>
<span class="sourceLineNo">544</span>  @Override<a name="line.544"></a>
<span class="sourceLineNo">545</span>  public ImmutableSortedMap&lt;K, V&gt; subMap(K fromKey, boolean fromInclusive, K toKey,<a name="line.545"></a>
<span class="sourceLineNo">546</span>      boolean toInclusive) {<a name="line.546"></a>
<span class="sourceLineNo">547</span>    checkNotNull(fromKey);<a name="line.547"></a>
<span class="sourceLineNo">548</span>    checkNotNull(toKey);<a name="line.548"></a>
<span class="sourceLineNo">549</span>    checkArgument(comparator().compare(fromKey, toKey) &lt;= 0,<a name="line.549"></a>
<span class="sourceLineNo">550</span>        "expected fromKey &lt;= toKey but %s &gt; %s", fromKey, toKey);<a name="line.550"></a>
<span class="sourceLineNo">551</span>    return headMap(toKey, toInclusive).tailMap(fromKey, fromInclusive);<a name="line.551"></a>
<span class="sourceLineNo">552</span>  }<a name="line.552"></a>
<span class="sourceLineNo">553</span><a name="line.553"></a>
<span class="sourceLineNo">554</span>  /**<a name="line.554"></a>
<span class="sourceLineNo">555</span>   * This method returns a {@code ImmutableSortedMap}, consisting of the entries<a name="line.555"></a>
<span class="sourceLineNo">556</span>   * whose keys are greater than or equals to {@code fromKey}.<a name="line.556"></a>
<span class="sourceLineNo">557</span>   *<a name="line.557"></a>
<span class="sourceLineNo">558</span>   * &lt;p&gt;The {@link SortedMap#tailMap} documentation states that a submap of a<a name="line.558"></a>
<span class="sourceLineNo">559</span>   * submap throws an {@link IllegalArgumentException} if passed a {@code<a name="line.559"></a>
<span class="sourceLineNo">560</span>   * fromKey} less than an earlier {@code fromKey}. However, this method doesn't<a name="line.560"></a>
<span class="sourceLineNo">561</span>   * throw an exception in that situation, but instead keeps the original {@code<a name="line.561"></a>
<span class="sourceLineNo">562</span>   * fromKey}.<a name="line.562"></a>
<span class="sourceLineNo">563</span>   */<a name="line.563"></a>
<span class="sourceLineNo">564</span>  @Override<a name="line.564"></a>
<span class="sourceLineNo">565</span>  public ImmutableSortedMap&lt;K, V&gt; tailMap(K fromKey) {<a name="line.565"></a>
<span class="sourceLineNo">566</span>    return tailMap(fromKey, true);<a name="line.566"></a>
<span class="sourceLineNo">567</span>  }<a name="line.567"></a>
<span class="sourceLineNo">568</span><a name="line.568"></a>
<span class="sourceLineNo">569</span>  /**<a name="line.569"></a>
<span class="sourceLineNo">570</span>   * This method returns a {@code ImmutableSortedMap}, consisting of the entries<a name="line.570"></a>
<span class="sourceLineNo">571</span>   * whose keys are greater than (or equal to, if {@code inclusive})<a name="line.571"></a>
<span class="sourceLineNo">572</span>   * {@code fromKey}.<a name="line.572"></a>
<span class="sourceLineNo">573</span>   *<a name="line.573"></a>
<span class="sourceLineNo">574</span>   * &lt;p&gt;The {@link SortedMap#tailMap} documentation states that a submap of a<a name="line.574"></a>
<span class="sourceLineNo">575</span>   * submap throws an {@link IllegalArgumentException} if passed a {@code<a name="line.575"></a>
<span class="sourceLineNo">576</span>   * fromKey} less than an earlier {@code fromKey}. However, this method doesn't<a name="line.576"></a>
<span class="sourceLineNo">577</span>   * throw an exception in that situation, but instead keeps the original {@code<a name="line.577"></a>
<span class="sourceLineNo">578</span>   * fromKey}.<a name="line.578"></a>
<span class="sourceLineNo">579</span>   *<a name="line.579"></a>
<span class="sourceLineNo">580</span>   * @since 12.0<a name="line.580"></a>
<span class="sourceLineNo">581</span>   */<a name="line.581"></a>
<span class="sourceLineNo">582</span>  @Override<a name="line.582"></a>
<span class="sourceLineNo">583</span>  public abstract ImmutableSortedMap&lt;K, V&gt; tailMap(K fromKey, boolean inclusive);<a name="line.583"></a>
<span class="sourceLineNo">584</span><a name="line.584"></a>
<span class="sourceLineNo">585</span>  @Override<a name="line.585"></a>
<span class="sourceLineNo">586</span>  public Entry&lt;K, V&gt; lowerEntry(K key) {<a name="line.586"></a>
<span class="sourceLineNo">587</span>    return headMap(key, false).lastEntry();<a name="line.587"></a>
<span class="sourceLineNo">588</span>  }<a name="line.588"></a>
<span class="sourceLineNo">589</span><a name="line.589"></a>
<span class="sourceLineNo">590</span>  @Override<a name="line.590"></a>
<span class="sourceLineNo">591</span>  public K lowerKey(K key) {<a name="line.591"></a>
<span class="sourceLineNo">592</span>    return keyOrNull(lowerEntry(key));<a name="line.592"></a>
<span class="sourceLineNo">593</span>  }<a name="line.593"></a>
<span class="sourceLineNo">594</span><a name="line.594"></a>
<span class="sourceLineNo">595</span>  @Override<a name="line.595"></a>
<span class="sourceLineNo">596</span>  public Entry&lt;K, V&gt; floorEntry(K key) {<a name="line.596"></a>
<span class="sourceLineNo">597</span>    return headMap(key, true).lastEntry();<a name="line.597"></a>
<span class="sourceLineNo">598</span>  }<a name="line.598"></a>
<span class="sourceLineNo">599</span><a name="line.599"></a>
<span class="sourceLineNo">600</span>  @Override<a name="line.600"></a>
<span class="sourceLineNo">601</span>  public K floorKey(K key) {<a name="line.601"></a>
<span class="sourceLineNo">602</span>    return keyOrNull(floorEntry(key));<a name="line.602"></a>
<span class="sourceLineNo">603</span>  }<a name="line.603"></a>
<span class="sourceLineNo">604</span><a name="line.604"></a>
<span class="sourceLineNo">605</span>  @Override<a name="line.605"></a>
<span class="sourceLineNo">606</span>  public Entry&lt;K, V&gt; ceilingEntry(K key) {<a name="line.606"></a>
<span class="sourceLineNo">607</span>    return tailMap(key, true).firstEntry();<a name="line.607"></a>
<span class="sourceLineNo">608</span>  }<a name="line.608"></a>
<span class="sourceLineNo">609</span><a name="line.609"></a>
<span class="sourceLineNo">610</span>  @Override<a name="line.610"></a>
<span class="sourceLineNo">611</span>  public K ceilingKey(K key) {<a name="line.611"></a>
<span class="sourceLineNo">612</span>    return keyOrNull(ceilingEntry(key));<a name="line.612"></a>
<span class="sourceLineNo">613</span>  }<a name="line.613"></a>
<span class="sourceLineNo">614</span><a name="line.614"></a>
<span class="sourceLineNo">615</span>  @Override<a name="line.615"></a>
<span class="sourceLineNo">616</span>  public Entry&lt;K, V&gt; higherEntry(K key) {<a name="line.616"></a>
<span class="sourceLineNo">617</span>    return tailMap(key, false).firstEntry();<a name="line.617"></a>
<span class="sourceLineNo">618</span>  }<a name="line.618"></a>
<span class="sourceLineNo">619</span><a name="line.619"></a>
<span class="sourceLineNo">620</span>  @Override<a name="line.620"></a>
<span class="sourceLineNo">621</span>  public K higherKey(K key) {<a name="line.621"></a>
<span class="sourceLineNo">622</span>    return keyOrNull(higherEntry(key));<a name="line.622"></a>
<span class="sourceLineNo">623</span>  }<a name="line.623"></a>
<span class="sourceLineNo">624</span><a name="line.624"></a>
<span class="sourceLineNo">625</span>  @Override<a name="line.625"></a>
<span class="sourceLineNo">626</span>  public Entry&lt;K, V&gt; firstEntry() {<a name="line.626"></a>
<span class="sourceLineNo">627</span>    return isEmpty() ? null : entrySet().asList().get(0);<a name="line.627"></a>
<span class="sourceLineNo">628</span>  }<a name="line.628"></a>
<span class="sourceLineNo">629</span><a name="line.629"></a>
<span class="sourceLineNo">630</span>  @Override<a name="line.630"></a>
<span class="sourceLineNo">631</span>  public Entry&lt;K, V&gt; lastEntry() {<a name="line.631"></a>
<span class="sourceLineNo">632</span>    return isEmpty() ? null : entrySet().asList().get(size() - 1);<a name="line.632"></a>
<span class="sourceLineNo">633</span>  }<a name="line.633"></a>
<span class="sourceLineNo">634</span><a name="line.634"></a>
<span class="sourceLineNo">635</span>  /**<a name="line.635"></a>
<span class="sourceLineNo">636</span>   * Guaranteed to throw an exception and leave the map unmodified.<a name="line.636"></a>
<span class="sourceLineNo">637</span>   *<a name="line.637"></a>
<span class="sourceLineNo">638</span>   * @throws UnsupportedOperationException always<a name="line.638"></a>
<span class="sourceLineNo">639</span>   * @deprecated Unsupported operation.<a name="line.639"></a>
<span class="sourceLineNo">640</span>   */<a name="line.640"></a>
<span class="sourceLineNo">641</span>  @Deprecated<a name="line.641"></a>
<span class="sourceLineNo">642</span>  @Override<a name="line.642"></a>
<span class="sourceLineNo">643</span>  public final Entry&lt;K, V&gt; pollFirstEntry() {<a name="line.643"></a>
<span class="sourceLineNo">644</span>    throw new UnsupportedOperationException();<a name="line.644"></a>
<span class="sourceLineNo">645</span>  }<a name="line.645"></a>
<span class="sourceLineNo">646</span><a name="line.646"></a>
<span class="sourceLineNo">647</span>  /**<a name="line.647"></a>
<span class="sourceLineNo">648</span>   * Guaranteed to throw an exception and leave the map unmodified.<a name="line.648"></a>
<span class="sourceLineNo">649</span>   *<a name="line.649"></a>
<span class="sourceLineNo">650</span>   * @throws UnsupportedOperationException always<a name="line.650"></a>
<span class="sourceLineNo">651</span>   * @deprecated Unsupported operation.<a name="line.651"></a>
<span class="sourceLineNo">652</span>   */<a name="line.652"></a>
<span class="sourceLineNo">653</span>  @Deprecated<a name="line.653"></a>
<span class="sourceLineNo">654</span>  @Override<a name="line.654"></a>
<span class="sourceLineNo">655</span>  public final Entry&lt;K, V&gt; pollLastEntry() {<a name="line.655"></a>
<span class="sourceLineNo">656</span>    throw new UnsupportedOperationException();<a name="line.656"></a>
<span class="sourceLineNo">657</span>  }<a name="line.657"></a>
<span class="sourceLineNo">658</span><a name="line.658"></a>
<span class="sourceLineNo">659</span>  private transient ImmutableSortedMap&lt;K, V&gt; descendingMap;<a name="line.659"></a>
<span class="sourceLineNo">660</span><a name="line.660"></a>
<span class="sourceLineNo">661</span>  @Override<a name="line.661"></a>
<span class="sourceLineNo">662</span>  public ImmutableSortedMap&lt;K, V&gt; descendingMap() {<a name="line.662"></a>
<span class="sourceLineNo">663</span>    ImmutableSortedMap&lt;K, V&gt; result = descendingMap;<a name="line.663"></a>
<span class="sourceLineNo">664</span>    if (result == null) {<a name="line.664"></a>
<span class="sourceLineNo">665</span>      result = descendingMap = createDescendingMap();<a name="line.665"></a>
<span class="sourceLineNo">666</span>    }<a name="line.666"></a>
<span class="sourceLineNo">667</span>    return result;<a name="line.667"></a>
<span class="sourceLineNo">668</span>  }<a name="line.668"></a>
<span class="sourceLineNo">669</span><a name="line.669"></a>
<span class="sourceLineNo">670</span>  abstract ImmutableSortedMap&lt;K, V&gt; createDescendingMap();<a name="line.670"></a>
<span class="sourceLineNo">671</span><a name="line.671"></a>
<span class="sourceLineNo">672</span>  @Override<a name="line.672"></a>
<span class="sourceLineNo">673</span>  public ImmutableSortedSet&lt;K&gt; navigableKeySet() {<a name="line.673"></a>
<span class="sourceLineNo">674</span>    return keySet();<a name="line.674"></a>
<span class="sourceLineNo">675</span>  }<a name="line.675"></a>
<span class="sourceLineNo">676</span><a name="line.676"></a>
<span class="sourceLineNo">677</span>  @Override<a name="line.677"></a>
<span class="sourceLineNo">678</span>  public ImmutableSortedSet&lt;K&gt; descendingKeySet() {<a name="line.678"></a>
<span class="sourceLineNo">679</span>    return keySet().descendingSet();<a name="line.679"></a>
<span class="sourceLineNo">680</span>  }<a name="line.680"></a>
<span class="sourceLineNo">681</span><a name="line.681"></a>
<span class="sourceLineNo">682</span>  /**<a name="line.682"></a>
<span class="sourceLineNo">683</span>   * Serialized type for all ImmutableSortedMap instances. It captures the<a name="line.683"></a>
<span class="sourceLineNo">684</span>   * logical contents and they are reconstructed using public factory methods.<a name="line.684"></a>
<span class="sourceLineNo">685</span>   * This ensures that the implementation types remain as implementation<a name="line.685"></a>
<span class="sourceLineNo">686</span>   * details.<a name="line.686"></a>
<span class="sourceLineNo">687</span>   */<a name="line.687"></a>
<span class="sourceLineNo">688</span>  private static class SerializedForm extends ImmutableMap.SerializedForm {<a name="line.688"></a>
<span class="sourceLineNo">689</span>    private final Comparator&lt;Object&gt; comparator;<a name="line.689"></a>
<span class="sourceLineNo">690</span>    @SuppressWarnings("unchecked")<a name="line.690"></a>
<span class="sourceLineNo">691</span>    SerializedForm(ImmutableSortedMap&lt;?, ?&gt; sortedMap) {<a name="line.691"></a>
<span class="sourceLineNo">692</span>      super(sortedMap);<a name="line.692"></a>
<span class="sourceLineNo">693</span>      comparator = (Comparator&lt;Object&gt;) sortedMap.comparator();<a name="line.693"></a>
<span class="sourceLineNo">694</span>    }<a name="line.694"></a>
<span class="sourceLineNo">695</span>    @Override Object readResolve() {<a name="line.695"></a>
<span class="sourceLineNo">696</span>      Builder&lt;Object, Object&gt; builder = new Builder&lt;Object, Object&gt;(comparator);<a name="line.696"></a>
<span class="sourceLineNo">697</span>      return createMap(builder);<a name="line.697"></a>
<span class="sourceLineNo">698</span>    }<a name="line.698"></a>
<span class="sourceLineNo">699</span>    private static final long serialVersionUID = 0;<a name="line.699"></a>
<span class="sourceLineNo">700</span>  }<a name="line.700"></a>
<span class="sourceLineNo">701</span><a name="line.701"></a>
<span class="sourceLineNo">702</span>  @Override Object writeReplace() {<a name="line.702"></a>
<span class="sourceLineNo">703</span>    return new SerializedForm(this);<a name="line.703"></a>
<span class="sourceLineNo">704</span>  }<a name="line.704"></a>
<span class="sourceLineNo">705</span><a name="line.705"></a>
<span class="sourceLineNo">706</span>  // This class is never actually serialized directly, but we have to make the<a name="line.706"></a>
<span class="sourceLineNo">707</span>  // warning go away (and suppressing would suppress for all nested classes too)<a name="line.707"></a>
<span class="sourceLineNo">708</span>  private static final long serialVersionUID = 0;<a name="line.708"></a>
<span class="sourceLineNo">709</span>}<a name="line.709"></a>




























































</pre>
</div>
</body>
</html>
